Skip to content

[SDK] Fix: Token price cache to use proper address #7230

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 30, 2025

Conversation

gregfromstl
Copy link
Member

@gregfromstl gregfromstl commented May 30, 2025


PR-Codex overview

This PR addresses a bug related to token pricing in the PayEmbed component by updating the cache key used in the conversion function.

Detailed summary

  • Updated the cacheKey in packages/thirdweb/src/pay/convert/cryptoToFiat.ts from convert-fiat-to-crypto-${to}-${chain.id} to convert-fiat-to-crypto-${fromTokenAddress}-${chain.id}.

✨ Ask PR-Codex anything about this PR by commenting with /codex {your question}

Summary by CodeRabbit

  • Bug Fixes
    • Resolved an issue with token pricing in the PayEmbed feature to improve accuracy when converting crypto to fiat.

@gregfromstl gregfromstl requested review from a team as code owners May 30, 2025 18:32
Copy link

changeset-bot bot commented May 30, 2025

🦋 Changeset detected

Latest commit: 1c43eab

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 2 packages
Name Type
thirdweb Patch
@thirdweb-dev/wagmi-adapter Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Copy link

vercel bot commented May 30, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs-v2 🛑 Canceled (Inspect) May 30, 2025 6:47pm
login ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 30, 2025 6:47pm
thirdweb_playground ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 30, 2025 6:47pm
thirdweb-www ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 30, 2025 6:47pm
wallet-ui 🛑 Canceled (Inspect) May 30, 2025 6:47pm

Copy link
Contributor

graphite-app bot commented May 30, 2025

How to use the Graphite Merge Queue

Add either label to this PR to merge it via the merge queue:

  • merge-queue - adds this PR to the back of the merge queue
  • hotfix - for urgent hot fixes, skip the queue and merge this PR next

You must have a Graphite account in order to use the merge queue. Sign up using this link.

An organization admin has enabled the Graphite Merge Queue in this repository.

Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue.

Copy link
Contributor

coderabbitai bot commented May 30, 2025

Walkthrough

This change modifies the cache key logic in the convertCryptoToFiat function within the PayEmbed feature of the "thirdweb" package. The cache key now uses the source token address and chain ID instead of the fiat currency symbol and chain ID, altering how price conversions are cached and retrieved.

Changes

Files/Paths Change Summary
packages/thirdweb/src/pay/convert/cryptoToFiat.ts Changed cache key in convertCryptoToFiat from using fiat currency symbol to using token address
.changeset/loose-tools-move.md Added patch notes describing the update to token pricing in PayEmbed

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant PayEmbed
    participant convertCryptoToFiat
    participant Cache

    User->>PayEmbed: Request token price conversion
    PayEmbed->>convertCryptoToFiat: Call with fromTokenAddress, chainId, to
    convertCryptoToFiat->>Cache: Check cache (fromTokenAddress + chainId)
    alt Cache hit
        Cache-->>convertCryptoToFiat: Return cached result
    else Cache miss
        convertCryptoToFiat->>PayEmbed: Fetch and compute price
        convertCryptoToFiat->>Cache: Store result with new key
    end
    convertCryptoToFiat-->>PayEmbed: Return conversion result
    PayEmbed-->>User: Show converted price
Loading

Possibly related PRs

Suggested reviewers

  • 0xFirekeeper

Warning

Review ran into problems

🔥 Problems

Errors were encountered while retrieving linked issues.

Errors (1)
  • TEAM-0000: Entity not found: Issue - Could not find referenced Issue.
✨ Finishing Touches
  • 📝 Generate Docstrings

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@github-actions github-actions bot added packages SDK Involves changes to the thirdweb SDK labels May 30, 2025
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
packages/thirdweb/src/pay/convert/cryptoToFiat.ts (1)

110-110: Excellent fix! Cache key now correctly reflects the cached data.

The change from using to (fiat currency) to fromTokenAddress in the cache key is correct because:

  1. The cached result depends on the token address and chain, not the target fiat currency
  2. The function always returns USD price (line 128: firstResult.price_usd * fromAmount) regardless of the to parameter
  3. The API query parameters match this cache key structure

Consider renaming the cache key to be more descriptive:

-      cacheKey: `convert-fiat-to-crypto-${fromTokenAddress}-${chain.id}`,
+      cacheKey: `token-price-usd-${fromTokenAddress}-${chain.id}`,

This would better reflect that it's caching USD token prices rather than suggesting a fiat-to-crypto conversion.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 913b243 and 1c43eab.

📒 Files selected for processing (2)
  • .changeset/loose-tools-move.md (1 hunks)
  • packages/thirdweb/src/pay/convert/cryptoToFiat.ts (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (8)
  • GitHub Check: Unit Tests
  • GitHub Check: E2E Tests (pnpm, esbuild)
  • GitHub Check: Size
  • GitHub Check: Build Packages
  • GitHub Check: Lint Packages
  • GitHub Check: E2E Tests (pnpm, webpack)
  • GitHub Check: E2E Tests (pnpm, vite)
  • GitHub Check: Analyze (javascript)
🔇 Additional comments (2)
packages/thirdweb/src/pay/convert/cryptoToFiat.ts (1)

128-128: Note: Function only supports USD despite to parameter.

The function always returns USD price regardless of the to parameter value. This aligns with the comment on line 36 stating "Only USD is supported at the moment."

Consider either:

  1. Removing the to parameter entirely since it's not used
  2. Adding validation to ensure to === "USD"
  3. Adding a TODO comment to implement multi-currency support in the future

The current implementation might be confusing to developers who expect different results when passing different to values.

.changeset/loose-tools-move.md (1)

1-6: Changeset documentation looks good.

The changeset properly documents this as a patch-level fix with an appropriate description that matches the PR objective.

Copy link
Contributor

size-limit report 📦

Path Size Loading time (3g) Running time (snapdragon) Total time
thirdweb (esm) 62.14 KB (0%) 1.3 s (0%) 260 ms (+113.46% 🔺) 1.6 s
thirdweb (cjs) 344.83 KB (0%) 6.9 s (0%) 972 ms (+11.8% 🔺) 7.9 s
thirdweb (minimal + tree-shaking) 5.7 KB (0%) 114 ms (0%) 99 ms (+1410.13% 🔺) 213 ms
thirdweb/chains (tree-shaking) 531 B (0%) 11 ms (0%) 53 ms (+2242.04% 🔺) 64 ms
thirdweb/react (minimal + tree-shaking) 19.52 KB (0%) 391 ms (0%) 57 ms (+315.5% 🔺) 448 ms

@gregfromstl gregfromstl merged commit 8245c06 into main May 30, 2025
20 of 21 checks passed
@gregfromstl gregfromstl deleted the greg/fix-token-price-cache branch May 30, 2025 18:48
@joaquim-verges joaquim-verges mentioned this pull request May 30, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
packages SDK Involves changes to the thirdweb SDK
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants